AddCollectionChange<TItem>(ICollection<TItem>,NotifyCollectionChangedAction,TItem,Int32,String) Method

Adds an UndoUnit for the specified add/remove collection change to the undo history.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function AddCollectionChange(Of TItem)( _
   ByVal collection As ICollection(Of TItem), _
   ByVal action As NotifyCollectionChangedAction, _
   ByVal changedItem As TItem, _
   ByVal index As Integer, _
   Optional ByVal itemTypeDisplayName As String _
) As UndoUnit

C#

public UndoUnit AddCollectionChange<TItem>( 
   ICollection<TItem> collection,
   NotifyCollectionChangedAction action,
   TItem changedItem,
   int index,
   string itemTypeDisplayName
)

Parameters

collection

The collection that was modified

action

Either 'Add' or 'Remove' to indicate the type of operation that occurred

changedItem

The item that was added or removed

index

The index of the new item for an Add operation or the index where the item existed for a Remove operation.

itemTypeDisplayName

A string representing the type of items in the collection as they should be presented to the end user or null to use the type name and/or item.

Type Parameters

TItem

The type of the item

Return Value

Returns the UndoUnit that was added or null if one was not added

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2